TagValueItem OAPI

In Surpass, you can attach metadata (known as “tags”) to items and then use these tags to organise items when authoring content, creating tests, and viewing results. Tags are made up of “tag groups” and “tag values”.

Tags are made up of categorised containers called “tag groups” that contain individual tags called “tag values”. For example, a tag group called “difficulty” might have the following tag values: “Easy”, “Medium”, and “Hard”.

The TagValueItem OAPI resource is used to see how many items the tag value is assigned to. For information on tag values and tag groups, read TagValue OAPI and TagGroup OAPI. To learn how to add tag values to items, read ItemMetadata OAPI.

This article explains what calls can be made to the Surpass OAPI using the TagValueItem resource.

Import this API into your Postman Workspace

Retrieving tag value usage

Send a request to the endpoint to retrieve tag value usage. The tag values are specified in the request body.

[
1
]

{
    "response": [
        {
            "id": 1,
            "usage": 5
        }
    ],
    "serverTimeZone": "GMT Standard Time"
}

Error Codes

Refer to the following table for information on error codes that may be encountered when using this resource.