Get detailed Group information

 

Short Description: This call will get your group-to-group relationships.

This endpoint must be run for each of the groups within the CCH account. One of two data sets will be returned. Either the JSON body will return a set of brackets "[]" showing that there are no parent-child relationships for that particular group, or at present the JSON body will return an array of groups.

 

NOTE: In the future we will have an endpoint that just holds the join table information. However, at this point in time everything about the parent Group is returned and you'll have to create your own join table, only adding the information you need to create and maintain the table.

JSON Calls documentation:

This object is comprised of the following simple objects:

Name Object Category Object Type Nullable Description
_href JSON Reference string 0

The URL to request that document from the API.
id CCH Structure integer 0

ID of the record.
country Content string 1

The country the address is located in.
date_created Content date 0

The date the record was created.
date_updated Content date 0

The date the record was updated.
postal_code Content string 1

The postal/zip code for the address.
time_created UCF Structure string  

The date and time the record was created.
time_updated UCF Structure string  

The date and time the record was last updated.
unspsc_code Content string  

The United Nations product and service code most applicable to the record.
account.id CCH Structure integer  

ID of the account record.
active_status CCH Structure string  

The status of the list. 'A' = active. 'D' = deprecated.
check_digit CCH Structure integer 0

We humans have to use numbers. However, when entering numbers, we humans also have a tendency to screw up the entry or copying of those numbers. A Dutch mathematician named Jacobus Verhoeff conducted a study of 12,000 numerical errors J. Verhoeff, Error Detecting Decimal Codes, Mathematical Centre Tract 29, The Mathematical Centre, Amsterdam, 1969, cited in Wagner and Putter, "Error Detecting Decimal Digits", CACM, Vol 32, No. 1 (January 1989), pp. 106-110. and from that, proposed a check digit calculation scheme http://www.augustana.ab.ca/~mohrj/algorithms/checkdigit.html#verhoeff that catches all single errors as well as all adjacent transpositions and most other errors.

To ensure that the IDs assigned by the system have integrity during input as well as distribution while being transferred into various formats (such as Excel, Word, Text, XML), each ID will also have its own checksum value stored in a checksum field.

Currently, the methodology for creating and verifying the checksum follows the Verhoeff calculation format.

The CheckDigit is created along with the record's ID as a calculation by the UCF database system. As such, once assigned it should never change because the ID will never change. A sample calculation format is shown in the use case scenarios.
creator._href JSON Reference URL 0

URL to get the user who created the list.
creator.id CCH Structure integer  

The ID of the user who created the list.
initatives._href JSON Reference URL 0

URL to get the list's initiatives from.
name   string  

The record’s name derived from the harmonized dictionary term assigned to the record.
account._href JSON Reference URL 0

URL to get the list's account information from.
ad_lists._href JSON Reference URL 0

URL to get the list's Authority Document information from.
children._href JSON Reference URL 0

URL to get the list's child records information from.
description Content string  

This is a CSS formatted HTML entry containing the Authority Document’s Official Name, it’s ID, availability, the current number of citations associated with it, and when it was last reviewed and released.
map_coordinates Content string  

The geographic coordinates associated with this record.
map_points Content string  

The coordinate points used to create a geographic fence.
map_zoom Content string  

The zoom level for the map associated with this record.
parents._href JSON Reference URL 0

URL to get the list's parent information from.
users._href JSON Reference URL 0

URL to get the list's user information from.

Use Cases

Within every organization, there are groups - groups that care about Governance, Risk, and Compliance (GRC), and groups that don’t.

To make it more complicated, there are also groups within groups, again, some caring about GRC and some not.

Each of these groups that do care about GRC should be communicated with regarding the Authority Documents they have to follow.

Because of that, the Common Controls Hub (CCH) allows you to create and manage groups, assign users, and even add groups within other groups. To see these group settings, click HERE and you’ll be taken to the appropriate part of the CCH.

The Group structure we create

Because of this nesting of groups within groups, the CCH creates a group structure that must utilize a parent-child join table to connect each group with its various parents. A simple ERD for this structure looks like the one below:

  1. These are the Groups that you’ll retrieve with the my-account endpoint.
  2. At this time you’ll need to create a join between the two with the parent.id in the join relating to the initial Group.
  3. You can then subset the initial Groups table by joining it as a child element.