Standard Collections
When there is a need to quickly identify and refer to a filtered collection of standards, the "Standard Collection" is what provides a solution. Standard Collection stores the filters object with a name and a guid as reference.
The "filters" is a JSON object that stores "filters (standard hierarchy)", "globalFilters". Searching filters are generated from this object to narrow down the result set the client wants to use.
The "name" identifies the standard collection in human readable format.
The "guid" identifies the standard collection in machine readable format.
The "filters" object
The "filters" object stores the filtering expression for the standard collection. This stores standard hierarchy and global filters which helps to filter to only the desired standards.
Here is a formal description about the filters object. For a practical explanation see the example below.
filters(object, required) - JSON API object forfiltersobject containing various fields like: "filters (standard hierarchy)", "globalFilters"filters(object) - Standard hierarchykey(string) - Standard hierarchy element ID (guid or "root")value(object) - Standard hierarchy element parameterscollections(array) - Array of GUIDs for the elements which are one level below in the hierarchy.id(GUID) - GUID of the element in the hierarchy. (Same as thekey.)parentId(GUID) - GUID for the element which is one level above in the hierarchy.state(string) - State is saying if the item element in the hierarchy is selected or not. Values can be: "checked"[+], "indeterminate"[-], "unchecked"[ ]type(string) - Type of position in the hierarchy. Values in hierarchical order: "region" > "publication" > "document" > "section" > "standard".
globalFilters(object) - Standard global filters: filtering by standard facetskey(string) - Standard facet description. (Eg:"document.publication.regions":)value(object) - Standard facet parametersguid(GUID) - GUID of the element in the hierarchy. (Eg.:"A832862C-901A-11DF-A622-0C319DFF4B22")name(text) - Value of the facet parameter. (Eg.:"California")
Example to build a "filter expression" from the "filters" object
Here is a filters object. Let's see how filter expression can be generated from it step-by-step:
The left side of the expression starts with filter[asset] =. There are two elements in the filters.facets array, so there will be two expressions on the right side. For example expressions expr_1 and expr_2. These are the basis of the filtering. The expr_1 is built up from filters.facets[0] and the expr_2 is built up from filters.facets[1].
Expressions are built up from a "field" and set of "values". The filter will give back those assets which have given the "values" on the given "field".
Let's find the "field" values. In the JSON object the "field" is defined by field.id.
Substitute these as "fields" into the filter expression.
Let's find the "values". The variables' names that are holding the "values" are defined by the facet.id. The "values" are those items in the selectedFilters object which have the object-path defined in the facet.id.
The variable for "values_1" is facet.id = "data.guid". Let's gather the values from selectedFilters.data.guid and generate the "values_1".
The variable for "values_2" is facet.id = "data.guid". Let's gather the values from selectedFilters.data.guid and generate the "values_2".
Finally substitute the "values" into the filter expression:
This example will filter only those assets which are in the grade: "Kindergarten" or "9th Grade" and are in the subject: "Mathematics".
Standard Collection
When there is a need to quickly identify and refer to a filtered collection of standards, the "Standard Collection" is what provides a solution. Standard Collection stores the filters object name and a guid as reference.
List All Standard Collections
To list Standard Collections the partner has access to, send a GET to the endpoint.
To find a Standard Collection by exact name, send a GET to the endpoint with the
collection_nameparameter. This gives back only the case sensitive exact match if there is any.To search Standard Collections by name, send a GET to the endpoint with the
search_collection_nameparameter. This search uses case insensitive partial matching.
Create a new Standard Collection
To create a Standard Collection within the AB Connects system, you send a POST request to the endpoint. The body of the POST contains the Standard Collection definition in JSON format.
The response will be the same as a GET by GUID request for the created Standard Collection.
Working with Standards Collection
Retrieving the Details of a Standard Collection
To get the Standard Collections you've created, call the endpoint with a GET while supplying the AB GUID for the Standard Collection. To retrieve the GUID, use the list and search functionality.
Modifying a Standard Collection
To update a Standard Collection, send a PATCH to the Standard Collection URL (with GUID) sending JSON in the body similar to that in the create statement. The JSON body only needs to contain the attributes that need to be updated. You can update the name or filters fields for the Standard Collection. You can update only one of these or all.
The response will contain the modified Standard Collection just as it would be in a GET by GUID request for the created Standard Collection.
Deleting a Standard Collection
To delete a Standard Collection you've created, send a DELETE the endpoint while supplying the AB GUID for the Standard Collection. If you have the name for the Standard Collection but not the AB GUID, see the section on searching for Standard Collections.
Last updated
Was this helpful?