REST API for Knowledge Management in Oracle Fusion Service

Get all user groups assigned to content type

get

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

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

The content type can be configured to allow content authors to associate the content with UserGroup objects. Content authors assign a user Group to the content, so that users with a certain level of access will have access to the content.

This resource supports the orderBy request parameter, which allows you to sort the returned list of UserGroup objects.

You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use 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

Request

Path Parameters

id(required): string

The unique identifier of the ContentType object

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList UserGroupKey

Type: object

Title: ResultList UserGroupKey

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.
items: array items
limit: integer

Actual paging size used by the server.
links: array links
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.

{
    "title":"ResultList UserGroupKey",
    "properties":{
        "hasMore":{
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"Actual paging size used by the server.",
            "type":"integer"
        },
        "count":{
            "description":"Number of resource instances returned in the current range.",
            "type":"integer"
        },
        "totalResults":{
            "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.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            },
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "offset":{
            "description":"Offset value used in the current page. ",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

Array of: object UserGroupKey

Title: UserGroupKey

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

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

Nested Schema : UserGroupKey

Type: object

Title: UserGroupKey

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.
links: array links
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
stripeCD: string

Stripe for UserGroup

{
    "title":"UserGroupKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe for UserGroup</p>",
            "type":"string"
        },
        "externalId":{
            "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>",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "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"
    ],
    "type":"object"
}

Examples

The following example shows how to find a list of User Group objects associated with the specified Content Type object by submitting a get request on the REST resource using cURL.

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/{id}/userGroups" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "recordId": "BDEE31CAA50A4DA7B9789240028BA4E3",
            "referenceKey": "INTERNAL",
            "name": "Internal",
            "links": [
                {
                    "rel": "canonical",
                    "href": "http://IM_REST_API_HOST/km/api/latest/userGroups/BDEE31CAA50A4DA7B9789240028BA4E3",
                    "mediaType": "application/json, application/xml",
                    "method": "GET"
                },
                {
                    "rel": "collection",
                    "href": "http://IM_REST_API_HOST/km/api/latest/userGroups",
                    "mediaType": "application/json, application/xml",
                    "method": "GET",
                    "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/userGroups"
                }
            ]
        }
    ],
    "hasMore": false,
    "limit": 20,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/SOLUTION/userGroups?limit=20&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}