Jump to

• Request
• Response
• Examples

Find by external ID

get

/km/api/v1/userGroups/accessLevel/{externalId}

This method returns a UserGroup object which is designated as an Access Level for the specified external ID.

Request

Path Parameters

• externalId: integer
  The user group external identifier

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : UserGroup

Match All

Show Source

• allOf UserGroupData

{
    "allOf":[
        {
            "$ref":"#/definitions/UserGroupData"
        }
    ]
}

Nested Schema : UserGroupData

Match All

Show Source

• allOf UserGroupKey
• object UserGroupData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/UserGroupKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the UserGroup object was created</p>"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"<p>The date when the UserGroup object was last modified</p>"
                },
                "objectId":{
                    "type":"string",
                    "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>"
                },
                "description":{
                    "type":"string",
                    "description":"The localized description of the user group"
                }
            }
        }
    ]
}

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 : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

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

Nested Schema : UserGroupKey-allOf[1]

Type: object

Show Source

• 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.

• name(optional): string

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

• 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

{
    "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 : UserGroupData-allOf[1]

Type: object

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
• 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

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the UserGroup object was created</p>"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the UserGroup object was last modified</p>"
        },
        "objectId":{
            "type":"string",
            "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>"
        },
        "description":{
            "type":"string",
            "description":"The localized description of the user group"
        }
    }
}

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: 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.

{
    "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"
    ]
}

Back to Top

Examples

The following example shows how to find an User Group by an unique external ID value and externaltype=rn_access_level value by submitting a get request on the REST resource using cURL.

cURL Command

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

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"

Example of Response Body

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

{
  "referenceKey" : "REFERENCEKEY_VALUE",
  "name" : "NAME_VALUE",
  "externalId" : 1428417268185,
  "externalType" : "EXTERNALTYPE_VALUE",
  "links" : [ {
    "rel" : "canonical",
    "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
    "mediaType" : "application/json, application/xml",
    "templated" : true,
    "method" : "GET",
    "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
  } ],
  "dateAdded" : "2013-04-23T21:06:19EDT",
  "dateModified" : "2013-04-23T21:06:19EDT",
  "description" : "DESCRIPTION_VALUE"
}

Back to Top