REST API for Knowledge Advanced in B2C Service

Get content type privileges for active user

get

/km/api/v1/contentTypes/privileges

This method returns list of names of privileges user is allowed in ContentTypes.

The complete list of ContentType privileges are :

BULK_CATEGORY_CHANGE
BULK_VIEW_CHANGE
DELETE
DELETE_HISTORY
IMPORT
MANAGE_CONTENT_REVIEW_TASKS
MANAGE_RATING_ANALYSIS_TASKS
MASTER_PUBLISH
MODIFY
PUBLISH
TRANSLATE
VIEW
CLEAR_CHECK_OUT

If user does not pass any URL parameter, then method returns the user's privileges for all ContentTypes. If user sets URL parameter contentTypeId, then the method returns the user's privilege of only the target ContentType.

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/contentTypes/privileges
The request returns list of all Content Type Privilege for the versioned Content.
http://<IM_REST_API_HOST>/km/api/latest/contentTypes/privileges?contentTypeId='CONTENT_TYPE_ID'
The request returns list of all Content Type Privilege for the versioned Content.

Request

Supported Media Types

application/json
application/xml

Query Parameters

contentTypeId(optional): string

The content type id or ref key identifier

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList CompositeContentType

Type: object

Title: ResultList CompositeContentType

Match All

Show Source

allOf Collection Paging Resource

Title: Collection Paging Resource

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

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

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

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

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(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 : Base Collection Resource-allOf[1]

Type: object

Show Source

items(optional): array items

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

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

count(optional): integer

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

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

Actual paging size used by the server.
offset(optional): integer

Offset value used in the current page.
totalResults(optional): 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 CompositeContentType-allOf[1]

Type: object

Show Source

items(optional): array items

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

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

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: object CompositeContentType

Title: CompositeContentType

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

Nested Schema : CompositeContentType

Type: object

Title: CompositeContentType

Show Source

contentTypeKeyBO(optional): ContentTypeKey
listOfPrivilege(optional): array listOfPrivilege

List of Privileges for the ContentType

{
    "title":"CompositeContentType",
    "properties":{
        "contentTypeKeyBO":{
            "$ref":"#/definitions/ContentTypeKey",
            "description":"ContentBO object being created or updated"
        },
        "listOfPrivilege":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of Privileges for the ContentType"
        }
    }
}

Nested Schema : ContentTypeKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the ContentType object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
                },
                "description":{
                    "type":"string",
                    "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
                }
            }
        }
    ]
}

Nested Schema : listOfPrivilege

Type: array

List of Privileges for the ContentType

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of Privileges for the ContentType"
}

Nested Schema : ContentTypeKey-allOf[1]

Type: object

Show Source

description(optional): string

The description for the ContentType object. Content Types support multiple languages.

This field identifies the object associated with the language specified by the user.
name(optional): string

The name for the ContentType object. The name field can only be used for sorting.

Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
recordId(optional): string

The unique identifier of the ContentType object.
referenceKey(optional): string

The reference key for the ContentType object.

ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the ContentType object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
        },
        "description":{
            "type":"string",
            "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
        }
    }
}

Examples

The following example shows how to find a list of user privileges available for a Content Type by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/contentTypes/privileges"

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.

{
  "items" : [ {
    "contentTypeKeyBO" : {
      "recordId" : "048016503b35e6fc0144e01818e2007b87",
      "referenceKey" : "SAMPLE_CHANNEL_NAME"
    },
    "listOfPrivilege" : [ "IMPORT", "DELETE_HISTORY", "VIEW", "BULK_CATEGORY_CHANGE", "MASTER_PUBLISH", "MANAGE_CONTENT_REVIEW_TASKS", "MODIFY", "BULK_VIEW_CHANGE", "IMPORT", "MANAGE_RATING_ANALYSIS_TASKS", "DELETE", "TRANSLATE", "PUBLISH" ]
  } ]
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 1
}