REST API for Knowledge Management in Oracle Fusion Service

Get a user group by reference key

get

/km/api/v1/userGroups/referenceKey/{referenceKey}

Retrieves the user group with the specified reference key.

Request

Path Parameters

referenceKey: string

The user group referenceKey identifier

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : UserGroup

Type: object

Title: UserGroup

Show Source

dateAdded(optional): string(date-time)

The date when the UserGroup object was created
dateModified(optional): string(date-time)

The date when the UserGroup object was last modified
description(optional): string

The localized description of the user group
externalId(optional): 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(optional): string

The ExternalType is the type of the corresponding userGroup from an external system.
links(optional): array links
localizedAttributes(optional): array localizedAttributes

List of LocalizedAttributes of this UserGroup in various Locales
name(optional): string

The localized name of the user group. The name field can only be used for sorting.
objectId(optional): string

The string representing the hierarchy of the user groups. All user groups are stored in the TAG table but they are currently not hierarchical
recordId(optional): string

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

The non localized name of the user group
stripeCD(optional): string

Stripe for UserGroup

{
    "title":"UserGroup",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this UserGroup in various Locales",
            "type":"array"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the UserGroup object was last modified</p>",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "objectId":{
            "description":"<p>The string representing the hierarchy of the user groups. All user groups are stored in the TAG table but they are currently not hierarchical</p>",
            "type":"string"
        },
        "description":{
            "description":"The localized description of the user group",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the UserGroup object was created</p>",
            "format":"date-time",
            "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 : localizedAttributes

Type: array

List of LocalizedAttributes of this UserGroup in various Locales

Show Source

Array of: object LocalizedAttributes

Title: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this UserGroup in various Locales",
    "type":"array"
}

Nested Schema : instanceLink

Type: object

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

Show Source

href: 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(optional): string

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

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

Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
rel: 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(optional): 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"
}

Nested Schema : LocalizedAttributes

Type: object

Title: LocalizedAttributes

Show Source

description(optional): string

Localized description in the above Locale
localeId(optional): string

RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
name(optional): string

Localized Name in the above Locale

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

Examples

The following example shows how to find a User Group object that has the specified reference key by submitting a get request on the REST resource using cURL.

curl -X "GET" "http://IM_REST_API_HOST/km/api/latest/userGroups/referenceKey/{referenceKey}"

Example of Request Header

The following shows an example of the request header.

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/userGroups/referenceKey/{referenceKey}" -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:

{
    "recordId": "8410EB4CB48C5E7CE05323BDF20A8468",
    "referenceKey": "EMPLOYEEHCM",
    "name": "Empleado",
    "links": [
        {
            "rel": "canonical",
            "href": "https://IM_REST_API_HOST>/km/api/v1/userGroups/8410EB4CB48C5E7CE05323BDF20A8468",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "collection",
            "href": "https://IM_REST_API_HOST>/km/api/v1/userGroups",
            "mediaType": "application/json, application/xml",
            "method": "GET",
            "profile": "https://IM_REST_API_HOST>/km/api/v1/metadata-catalog/userGroups"
        }
    ],
    "dateAdded": "1970-01-01T23:11:11+0000",
    "dateModified": "1970-01-01T23:11:11+0000",
    "objectId": "-3",
    "description": "Grupo de usuarios EMPLOYEE para el departamento HCM",
    "localizedAttributes": [
        {
        
        {
            "localeId": "da_DK",
            "name": "Medarbejder",
            "description": "EMPLOYEE brugergruppe til HCM-afdelingen"
        },
        {
            "localeId": "en_AU",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_CA",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_GB",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_HK",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_ID",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IE",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IL",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IN",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_IS",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_NZ",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_SG",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_US",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "en_ZA",
            "name": "Employee",
            "description": "EMPLOYEE user group for the HCM Department"
        },
        {
            "localeId": "es_AR",
            "name": "Empleado",
            "description": "Grupo de usuarios EMPLOYEE para el departamento HCM"
        }
        
            ],
    "stripeCd": "ORA_SVC_HCM"
}