Role Endpoints

This document explains the methods you may use to work with the Role endpoints in the Federated Authority Document database.

Getting Role

Quick-start Knowledge

• The full JSON-LD Role object is defined at https://grcschema.org/Role.

• Getting a list of Role objects from the Federated Authority Document Database is accomplished by querying the https://grcschema.p.rapidapi.com/Role endpoint using a REST GET. Optional parameters may be provided to filter and paginate the result.

Role List GET

• Getting a list of Role object from the Federated Authority Document Database is accomplished by querying the https://grcschema.p.rapidapi.com/Role endpoint using a REST GET with no optional parameters.

• Provides a list of all Role objects as Universal Stubs.

• Pagination is provided for the list where count is the total quantity of objects in the data-set, limit is how many objects are returned in the current list, and offset is the first object in the set from that offset point. This is configurable in the request, but the default is a limit of 50 objects starting from offset 0.

In the below example, with a limit of 2, page 1 starts from offset 0 with two values (limit). Page 2 starts from offset= 2. Page 3 from offset= 4, etc. There would be 5 pages to display the data - two objects at a time. This is illustrative only, and the actual local pages will depend on your limit and count.

{
    "Pagination": {
        "@context": "http://grcschema.org/",
        "@type": "Pagination",
        "count": 650,
        "limit": 2,
        "offset": 0
    },
    "@set": [
        {
            "@context": "http://grcschema.org/",
            "@type": "Stub",
            "id": 1,
            "property_name": "name",
            "property_value": "Marketing",
            "thing_type": "Role"
        },
        {
            "@context": "http://grcschema.org/",
            "@type": "Stub",
            "id": 2,
            "property_name": "name",
            "property_value": "Define and Manage Business Value",
            "thing_type": "Role"
        }
    ]
}

Role List GET (filtered)

• Getting a filtered list of Role objects from the Federated Authority Document Database is accomplished by querying the https://grcschema.p.rapidapi.com/Role/ endpoint using a REST GET with url parameters.

• These are the parameters you can optionally supply to the filter. These fields work as a logical AND.

Field	Description
name	Filters by Role name
search	Searches across all searchable fields.
sort_dir	0 = descending, 1 = ascending
limit	Combined with offset, provides pagination by limiting results.
offset	Combined with limit, provides pagination by shifting the first record.

Role GET (by ID)

• Getting a single Role object from the Federated Authority Document Database is accomplished by querying the https://grcschema.p.rapidapi.com/Role/:id endpoint using a REST GET.