REST API for Knowledge Advanced in B2C Service

Get user groups

get

/km/api/v1/views/{id}/userGroups

This method returns a list of UserGroup objects associated with the View object having the specified ID parameter.

This resource supports the orderBy request parameter. You can use this parameter along with the HTTP service request to sort the returned list.

You must get the schema and catalog of the resource for additional values that you can use with the orderBy parameter. To get the schema and catalog of the resource, you must use the GET method with the mediaType value as application/schema+json in the HTTP request.

The example URI to get schema and catalog of the resource is as follows:

http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/userGroups

Example URIs:

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/views/{id}/userGroups
The method returns a list of UserGroup objects associated with the View object having the specified ID parameter sorted by reference key in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/views/{id}/userGroups?orderBy=referenceKey:desc
The method returns a list of UserGroup objects associated with the View object having the specified ID parameter sorted by reference key in descending order.

Request

Path Parameters

id(required): string

The unique identifier of the View object

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList UserGroupKey

Type: object

Title: ResultList UserGroupKey

Match All

Show Source

allOf Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.
object ResultList UserGroupKey-allOf[1]

{
    "title":"ResultList UserGroupKey",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserGroupKey"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Oracle base collection resource schema definition.

Show Source

allOf Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.
object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Oracle base collection resource schema definition.

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links: array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : Base Collection Resource-allOf[1]

Type: object

Show Source

items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

count: integer

Number of resource instances returned in the current range.
hasMore: boolean

Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
limit: integer

Actual paging size used by the server.
offset: integer

Offset value used in the current page.
totalResults: integer

Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList UserGroupKey-allOf[1]

Type: object

Show Source

items: array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/instanceLink"
    }
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

href(required): string

URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
mediaType: string

Media type, as defined by RFC 2046, describing the link target.
method: string

HTTP method for requesting the target of the link.
profile: string

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
rel(required): string

Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
templated: boolean

Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

Array of: UserGroupKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserGroupKey"
    }
}

Nested Schema : UserGroupKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object UserGroupKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The non localized name of the user group</p>"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>"
                },
                "externalId":{
                    "type":"integer",
                    "description":"<p>The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.</p>"
                },
                "externalType":{
                    "type":"string",
                    "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>"
                }
            }
        }
    ]
}

Nested Schema : UserGroupKey-allOf[1]

Type: object

Show Source

externalId: integer

The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.
externalType: string

The ExternalType is the type of the corresponding userGroup from an external system.
name: string

The localized name of the user group. The name field can only be used for sorting.
recordId: string

The unique identifier from the TAG table that represent a userGroups resource
referenceKey: string

The non localized name of the user group

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The non localized name of the user group</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>"
        },
        "externalId":{
            "type":"integer",
            "description":"<p>The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.</p>"
        },
        "externalType":{
            "type":"string",
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>"
        }
    }
}

Examples

The following example shows how to find a list of User Group objects associated with the View object having the specified ID parameter by submitting a GET request on the REST resource using cURL.

cURL Command Example

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/views/{id}/userGroups

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Response Body Example

The following shows an example of the response body in JSON format.

{
  "items" : null,
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 0
}