REST API for Knowledge Management in Oracle Fusion Service

Get all views assigned to content

get

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

This method returns a list of View objects associated with the Content 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 can use following values with the orderBy parameter:

recordId
referenceKey
name
dateAdded
dateModified

Example URIs

Following are the example URIs for this method:

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

Request

Path Parameters

id: string

The unique identifier of the Content object

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : ResultList ViewKey

Type: object

Title: ResultList ViewKey

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

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

{
    "title":"ResultList ViewKey",
    "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/ViewKey"
            },
            "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 ViewKey

Title: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "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 : ViewKey

Type: object

Title: ViewKey

Show Source

links(optional): array links
name(optional): string

Localized name of the view
recordId(optional): string

GUID of the SITE table containing the view definition
referenceKey(optional): string

Non localized reference key for the view
stripeCD(optional): string

Stripe of a view

{
    "title":"ViewKey",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        }
    }
}

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

Examples

The following example shows how to get a list of View objects associated with the Content object having the specified ID parameter:

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

Example of Response Body

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

{
  "items": [
    {
      "recordId": "BBA181DFB52148779A416184A191B2AF",
      "referenceKey": "SERVICE",
      "name": "Service",
      "links": [
        {
          "rel": "parent",
          "href": "https://<IM_REST_API_HOST>/km/api/latest/views/FBA17E28CAAB4A7387A44BEE77240E33",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "canonical",
          "href": "https://<IM_REST_API_HOST>/km/api/latest/views/BBA181DFB52148779A416184A191B2AF",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "https://<IM_REST_API_HOST>/km/api/latest/views",
          "mediaType": "application/json, application/xml",
          "method": "GET",
          "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/views"
        }
      ]
    }
  ],
  "hasMore": false,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/content/27BA7D089309424D86657C14C4B637A6/views?limit=20&offset=0&_=1543215383643",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 1
}